Skip to content
This repository has been archived by the owner on May 11, 2022. It is now read-only.

Commit

Permalink
Merge pull request #10 from TheRenegadeCoder/readme-update-for-pip
Browse files Browse the repository at this point in the history
Added Additional Directions to README for Pip
  • Loading branch information
jrg94 authored Aug 12, 2018
2 parents 1d6e1af + 61c2b95 commit c8f9cd6
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,24 @@ like the number of scripts per language and links to articles and issues.

## How to Run

At this time, the wiki generator is hardcoded for the Sample Programs repo. In order to run it,
you'll need a copy of the Sample Programs repo:
At this time, the wiki generator is hardcoded for the Sample Programs repo. In order to run it,
you can install it as a package using `pip`:

`pip install generate_wiki`

After that, you'll need a copy of the Sample Programs repo:

`git clone https://github.com/TheRenegadeCoder/sample-programs.git`

Then, you'll want to run the `generate_wiki.py` script as follows:
Finally, you can build the wiki using the following command:

`wikig /path/to/sample-programs/repo/archive`

Alternatively, you can clone this repo to run the `generate_wiki.py` script directly:

`python generate-wiki.py /path/to/sample-programs/repo/archive`

The solution is designed to then handle repo exploration from the `/archive/` directory. If successful, you should
Both solutions are designed to handle repo exploration from the `/archive/` directory. If successful, you should
begin to see print statements for the various links under test for The Renegade Coder. When finished, you'll
have a `/wiki/` directory next to your script which contains the wiki.

Expand Down

0 comments on commit c8f9cd6

Please sign in to comment.