Merge pull request 'zav-2/add-readme' (#1) from zav-1/readme into master

Reviewed-on: https://git.zavage.net/Zavage-Software/wikicrawl/pulls/1
This commit is contained in:
zavage 2024-11-15 05:37:19 -07:00
commit 39874c533d

@ -1,8 +1,9 @@
= Wikicrawl = # Wikicrawl
This application plays the road to philosophy game on wikipedia. An This application plays the road to philosophy game on wikipedia. An
interface is given where the user can launch a browser and have it interface is given where the user can launch a browser and have it
repeatedly click the first link on wikipedia articles until it reaches the article on philosophy. Apparently this works for ~97% repeatedly click the first link on wikipedia articles until it reaches the article on philosophy. Apparently this works for ~97%
of pages. of pages. (UPDATE) I have heard this has CHANGED, with the structure of wikipedia pages. I'm curious what happens now.
settings.py: Contains runtime parameters. There are a few things settings.py: Contains runtime parameters. There are a few things
that need configured correctly for this to run. that need configured correctly for this to run.
@ -13,6 +14,21 @@ setup.py: Installation configuration for third-party dependencies.
To install, run these commands in this directory: To install, run these commands in this directory:
(old instructions, i recommend pyenv on Linux)
virtualenv pythonenv virtualenv pythonenv
python setup.py install python setup.py install
python ./launcher.py python ./launcher.py
# Demo Videos on Youtube
* https://www.youtube.com/watch?v=aFyQLUPXnU4
* https://www.youtube.com/watch?v=Nh6ORbKOHnI
* https://www.youtube.com/watch?v=DpuhHoPsSVM
# Contact
* mat@zavage.net