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

UserManual.pdf missing from repo #6

Closed
panicsteve opened this issue May 29, 2015 · 8 comments
Closed

UserManual.pdf missing from repo #6

panicsteve opened this issue May 29, 2015 · 8 comments

Comments

@panicsteve
Copy link
Collaborator

@panicsteve panicsteve commented May 29, 2015

The .tex source appears to have survived the move from Google Code, but the PDF is missing.

It is referenced on the wiki page for dumping the ROM:

https://github.com/pguyot/Einstein/wiki/Dumping-The-Rom

@pguyot

This comment has been minimized.

Copy link
Owner

@pguyot pguyot commented Jun 3, 2015

I definitely do have the binary that was generated from the .tex file. However, does it really belong here? GitHub deprecated downloads and this isn't a release file…

@splorp

This comment has been minimized.

Copy link
Collaborator

@splorp splorp commented Jun 3, 2015

I think it’s useful to have properly formatted documentation available, particularly for users that perhaps cannot work with sources like .tex files.

GitHub still supports binaries, regardless of their stance on downloads.

Why not create a documentation directory or similar?

pguyot added a commit that referenced this issue Jun 3, 2015
@panicsteve

This comment has been minimized.

Copy link
Collaborator Author

@panicsteve panicsteve commented Jun 3, 2015

It might make sense to integrate the documentation into the GitHub wiki for this project. This would make it easy for other project members to update moving forward, and easier to find for people just experimenting with running Einstein.

If you agree and can supply the file in plain text, I'm willing to help convert it into markdown wiki pages.

@pguyot

This comment has been minimized.

Copy link
Owner

@pguyot pguyot commented Jun 3, 2015

Noted. We do have a Documentation directory, where the source code for the documentation lies (.tex and images), now along with the generated PDF that was on Google Code.

@pguyot pguyot closed this Jun 3, 2015
@pguyot

This comment has been minimized.

Copy link
Owner

@pguyot pguyot commented Jun 3, 2015

@panicsteve I am all for converting the documentation to the Wiki, at least the essential parts such as getting a ROM.

@morgant

This comment has been minimized.

Copy link

@morgant morgant commented Jun 3, 2015

You can clone & edit GitHub wikis locally, so presumably you could put the PDF in there as well.

@splorp

This comment has been minimized.

Copy link
Collaborator

@splorp splorp commented Jun 3, 2015

+1

@panicsteve

This comment has been minimized.

Copy link
Collaborator Author

@panicsteve panicsteve commented Jun 19, 2015

I have copied the information on dumping the ROM from the UserManual.pdf to the corresponding wiki page.

panicsteve pushed a commit that referenced this issue Jul 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.