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

Create a Manual detailing use of the Jagati. #73

Open
20 tasks
Sqeaky opened this issue Aug 20, 2018 · 0 comments
Open
20 tasks

Create a Manual detailing use of the Jagati. #73

Sqeaky opened this issue Aug 20, 2018 · 0 comments
Milestone

Comments

@Sqeaky
Copy link
Member

Sqeaky commented Aug 20, 2018

A manual, preferably one well integrated into our other docs, needs to be created. This manual needs to cover a series of basic tasks and tickets for those should be made. This manual should be along the same level of sophistication and detail as The DAG Frame Scheduler Manual.

Some of those tasks this describe and details this might include should be:

  • Start writing the docs somewhere (StaticFoundation?) and provide something the rest of these might be jammed into.
  • Explain what the index and how to use a different index.
  • Make all repos on a machine use the same source folder or different source and why that might be good.
  • Control whether or not Jagati files are downloaded.
  • Explain how the checksumming works and how it is a security feature.
  • How to create build config files and explain the problems that solves.
  • Say something about project structure and explain the opinions the Jagati enforces.
  • List all jagati variables.
  • Explain all the variables can be pre/overloaded.
  • Describe OS, Compiler and CPU detection in detail, and describe the relation with Mezz_StaticFoundation.
  • Describe file lists and provide a few examples.
  • Show how to run the unit tests.
  • Explain how to use the code coverage feature to let people know how to figure out their test coverage.
  • Explain the opinion about each Jagati Package having one lib, one exe, and one tester.
  • Describe Doxygen integration.
  • Explain the presumptions the Jagati makes during linking.
  • Describe how to add 3rd party libraries manually.
  • Describe automated test executable generation with Mezz_Test.
  • Explain the IDE Visibility feature.
  • Explain how this uses/abuses git.

Check these off once other tickets are made. Close this ticket once all are complete. This list should be updated as needed.

@Sqeaky Sqeaky added this to the 1.0 milestone Aug 20, 2018
@Sqeaky Sqeaky modified the milestone: 1.0 Nov 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant