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

Reworking README #56

Open
dennisguse opened this issue Nov 11, 2016 · 1 comment
Open

Reworking README #56

dennisguse opened this issue Nov 11, 2016 · 1 comment

Comments

@dennisguse
Copy link

The current README contains only limited information especially considering new people interested in the SSR.

I believe it would be great to add:

  • Brief description of the SSR (Goal, Features, Limits)
  • Basic information (Website, Mailing list, Wiki, License)
  • Supported platforms (MACOS, Linux, PD?)
  • How to compile the SSR on some basic platforms NOTE: I know the INSTALL contains some information, but that is rather hard to read.

In addition, I would remove the (c) as it is not really something important for users/developers and either remove it or move it to a different place.

Also, I would prefer to use Markdown instead of plain/reStructuredText.

What do you think?

@chohner
Copy link
Contributor

chohner commented Nov 18, 2016

Some information on how to compile is in operation.rst. This pull request contains a commit that expands a bit on the steps required on OSX - Probably still not a bad idea to refactor this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants