Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the project contents a little bit more attractive #74

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions Dependencies.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
Dependencies
------------

[https://github.com/the-xkcd-community/the-red-spider-project]
https://github.com/the-xkcd-community/the-red-spider-project


Required for the setup script, `rsshell` and several commands:
Strictly required:

- [Python 2.7](http://www.python.org/download/) (unixy systems should have a `python2` link).
- [Python 2.7](http://www.python.org/download/) (unixy systems should have a `python2` link), in order to run the setup script, `rsshell`, `rshelp` and many other commands.

Recommended:

- Git, in order to participate (see [GitImmersion](http://gitimmersion.com/index.html) for installation and a tutorial);

Required for the `level_up` command:

Expand All @@ -17,9 +21,9 @@ Required for the `fortune` command:
- [lxml](http://lxml.de/)
- [cssselect](https://pypi.python.org/pypi/cssselect)

Other dependencies:
Optional dependencies:

- Git, in order to participate (see [GitImmersion](http://gitimmersion.com/index.html) for installation and a tutorial);
- [PHP](http://www.php.net/downloads.php) for [zed0/advbrowser](https://github.com/zed0/the-red-spider-project/tree/advbrowser);
- [Visual C#](http://msdn.microsoft.com/en-us/vstudio/hh341490.aspx) for [BRNMan/master](https://github.com/BRNMan/the-red-spider-project);
- [Visual C#](http://msdn.microsoft.com/en-us/vstudio/hh341490.aspx) *or* [Mono](http://mono-project.com) for [mrhmouse/rsp-tutorial](https://github.com/mrhmouse/the-red-spider-project/tree/rsp-tutorial)
- C++ on Windows (any compiler) for [xen-0/game-of-spiders](https://github.com/xen-0/the-red-spider-project/tree/game-of-spiders).
2 changes: 1 addition & 1 deletion Platforms.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Platforms
---------

[https://github.com/the-xkcd-community/the-red-spider-project]
https://github.com/the-xkcd-community/the-red-spider-project


Anything on the integration branch should have been tested on a recent
Expand Down
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The Red Spider Project
----------------------

[https://github.com/the-xkcd-community/the-red-spider-project]
https://github.com/the-xkcd-community/the-red-spider-project


### Why ###
Expand All @@ -25,7 +25,7 @@ For the impatient: fork the project, then
The project is like a small, self-contained operating system layered
on top of your actual operating system. People can add programs at
will. It's an open-ended process without deadlines or a final goal and
we're very open-minded.
we're very open-minded. Anyone who wants to contribute can join.


### What ###
Expand Down
28 changes: 19 additions & 9 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
#! /usr/bin/env python2
from __future__ import print_function

''' setup.py
Initial setup script for the Red Spider Project

Copyright 2012, 2013 Julian Gonggrijp
Copyright 2012-2014 Julian Gonggrijp
Copyright 2013 Christoph Baumgartner
Licensed under the Red Spider Project License.
See the License.txt that shipped with your copy of this software for details.


A -q option to make it less verbous would probably be nice. Until we
A -q option to make it less verbose would probably be nice. Until we
have a dedicated 'update' command we'll need to run the setup every
time one of the commands has been changed on master.
'''

from __future__ import print_function
from future_builtins import zip, map
import os
from os.path import exists, join, split, splitext, abspath, expanduser
Expand Down Expand Up @@ -58,7 +59,7 @@ def __call__(self, check):
return self

YES = SomeChoice(
"y", "ye", "yes", "aye", "affirmative", "roger", "okay", "kay",
"y", "ye", "yes", "aye", "affirmative", "roger", "okay", "kay",
"sure", "fine", "all right", "certainly", "definitely"
)
NO = SomeChoice(
Expand Down Expand Up @@ -303,23 +304,32 @@ def install_docs (docs):
In addition the root has been saved to RED_SPIDER_ROOT, so after your
next logon that one will be permanently available as well.

Note for unixy systems: opening a new terminal window might count as a
new logon. If you run me often, you may want to clean up ~/.profile
once in a while..."""
Note for unixy systems: if you run me often, you may want to clean up
~/.profile once in a while..."""

install_patience_msg = """
Please wait while I install the rest..."""

script_not_found_msg = """I can't find {0} so I'll skip it."""

if os.name == 'nt': # Windows
usr_env_reload_cmd = 'for /f "tokens=3* skip=2" %i in (\'reg query "HKCU\Environment" /v RED_SPIDER_ROOT\') do (set RED_SPIDER_ROOT=%i)'
else: # POSIX
usr_env_reload_cmd = 'source ~/.profile'

farewell_msg = """
We're done! But wait, don't walk away yet.
We're done! Now all you need to do is run these commands:

{0}
rsshell

But wait, don't walk away yet.
This is important: if you ever decide to move the Red Spider Project
to another directory, you'll have to run me again or otherwise my dear
friend rsshell might choke and call you an inconsiderate boor.
Just kidding! But seriously, do come back to me if you ever move the
project to somewhere else.
"""
""".format(usr_env_reload_cmd)

if __name__ == '__main__':
main()
Expand Down