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

Feature/update readme #133

Merged
merged 1 commit into from
Aug 1, 2020

Conversation

formatc1702
Copy link
Collaborator

I've restructured the main README file, added and moved around some of the information. I welcome any new input to make the readme more user-friendly.

@formatc1702 formatc1702 changed the base branch from dev to feature/syntax-description July 27, 2020 19:20
@formatc1702
Copy link
Collaborator Author

A better description for the build_examples.py options is probably a good thing to add.

Comment on lines +109 to +112
git clone <repo url>
cd <working copy>
git checkout dev
pip3 install -e .
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure this workflow makes sense.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should you also mention something like the alternative variant you gave to me in #43 (comment)?

git clone https://github.com/formatc1702/WireViz.git
cd WireViz/
python -m venv wv-env
source wv-env/bin/activate
pip3 install -e .
cd src/wireviz
python build_examples.py

Note that git checkout dev is missing above, and I have not tried any of these installations from scratch recently.

Copy link
Collaborator

@kvid kvid Jul 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be a link to CONTRIBUTING.md near the end of the section about Installing the development version?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, didn't see these comments earlier.

  • I'm not sure whether we should give advice on virtual environments directly, or reference a site that explains the concept more generally.
  • Sure, I can include a link to CONTRIBUTING.md

@formatc1702 formatc1702 added this to the v0.2 = PRIORITY milestone Jul 27, 2020
@kvid
Copy link
Collaborator

kvid commented Jul 27, 2020

A better description for the build_examples.py options is probably a good thing to add.

See PR #118 description for a short summary in the Usage section, and a couple of use cases in the last section, to get some ideas.

@formatc1702
Copy link
Collaborator Author

It might make sense to create a docs/ directory or similar, for the changelog, the syntax description, and the build_examples.py documentation. This way we don't overload the readme, or the parent directory.
In the future, this can be replaced by a properly built documentation system.

@formatc1702 formatc1702 merged commit 3729efa into feature/syntax-description Aug 1, 2020
@formatc1702 formatc1702 deleted the feature/update-readme branch August 1, 2020 20:08
@formatc1702
Copy link
Collaborator Author

formatc1702 commented Aug 1, 2020

I'm merging this into feature/syntax-description since they are closely related; let's continue the discussion in #111.

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

Successfully merging this pull request may close these issues.

2 participants