diff --git a/README.md b/README.md new file mode 100644 index 0000000..77770a1 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Chronologue +---------------- +by [The Good Docs Project](thegooddocsproject.dev) + +The Chronologue project is a sample, completely fictional open source project used to create examples of typical open source project documentation. + +Chronologue helps you see what the The Good Docs Project [templates](https://www.github.com/thegooddocsproject/templates) look like in action, with actual content. + +### Why a fictional project? + +We could link to real projects that have great documentation (whether or not they use our templates) but we would have to keep checking to make sure our recommendations and those projects' docs were still in sync. + +By using a fictional project we can also give examples of what _not_ to do without hurting anyone's feelings. + +### How Can I Use Chronologue? + +Please, use Chronologue for entertainment purposes only! + +Actually, you are free to link to, reproduce, or repurpose this text, within the bounds of our [license](/LICENSE). + +We hope you find Chronologue useful as a way to explore technical writing and open source project documentation using templates. + +### How Can I Contribute to Chronologue? + + +### Where is the Chronologue README? + +The README for the Chronologue project is [README2.md](/README2.md). diff --git a/README2.md b/README2.md new file mode 100644 index 0000000..97b759f --- /dev/null +++ b/README2.md @@ -0,0 +1,25 @@ +# Chronologue Project +---------------- +by [The Good Docs Project](thegooddocsproject.dev) + +Chronologue is an open source calendrical toolkit for time travel, including various utilities for developers working on time travel technology, including but not limited to time-travel devices (“time machines”), farviewers, and other IoT (internet of time) or “time-tech” applications, to convert between calendrical systems. + +Although the major calendrical systems (e.g. the Gregorian calendar, the Hijra calendar, Unix time) are adequate for most temporally-sequential use cases, they are not well-adapted for activities that involve traversing timestreams. Chronologue tools and libraries help developers convert between, among, and across traditional calendrical systems. + +Chronologue includes: + +* The Chronologue Time Standard (CTS), which provides consistent time coordinates across timelines +* Test suites for integrations or applications using the Chronologue Time Standard +* Tools for conversion between the Gregorian, Mayan, and Hijri calendars and the Chronologue Time Standard (CTS) + +Chronologue does not support self-crossing timestreams (for example—warning The Good Place spoilers—the [Jeremy Bearimy](https://www.youtube.com/watch?v=RFm9ClqlGuo&feature=youtu.be&t=32) timeline). + +## Using Chronologue + +Please see our [LICENSE](/LICENSE) file (CC-BY 4.0). + +Please note: you are explicitly permitted to create closed-source conversion tools between the Chronologue Time Standard and proprietary calendars (for example, Swatch Internet Time, also known as ‘[.beat time](https://en.wikipedia.org/wiki/Swatch_Internet_Time)’). + +## Contributing to Chronologue + +