This folder contains standard templates for software engineering written in Markdown. The Requirements Analysis Document and Software Design Documents are stored in a KabukiPress tree structure because it speeds up Markdown rendering, it helps block out distractions, and it's more programmer-friendly.
The directions for how to use the templates are stored in the Astartup™ Cookbook. There are different Markdown templates for different tasks:
- Markdown Software Engineering
- Markdown Game Design
- Markdown Cookbook
The mission of Markdown Software Engineering is to help you start out or get your project onto the right foot and increase productivity with Don't Repeat Yourself (DRY) documentation. Our vision is to automate as much documentation as possible with KabukiPress.
When you're first starting out your project, your roadmap should be here in the root readme file because people have very low tolerance for non-working code, they will just move on in search of the easy thing and you can't blame them, so if you're trying to woo contributors, you must do it with your Mission and vision, then immediately after show the action plan that someone else things is a good idea achievable, and worth their time to contribute too.
We can achieve a Minimum Viable Product by completing the following project phases:
- Foo - In this phase we will say hello world.
- Bar - In this phase we will say Foo and Bar.
This is a good idea because foo and bar are both common names for abstract functions.
1. Clone the repo:
git clone https://github.com/KabukiStarship/MarkdownSoftwareEngineering.git2. Copy the documents you want into your repo, but do not copy the .git folder because it will mess up the GitHub templates.
3. We've found Visual Studio Code to the best Markdown editor. Open Visual Studio Code, right click on the Explorer, and click on Add Folder to Workspace, then point it to your project repo's root folder.
4. Find and replace all instances of "Markdown Software Engineering" with your projects name, and find and replace all instances of "Cale McCollough <https://your-github-page.github.io>" with Cale McCollough and a pointer to your GitHub page. Please don't put your personal email on the copyright, you want to make them contact you through a website so you can keep your personal information private.
5. Delete the lines in the License you don't need.
6. To upload the files to the web, just upload them to your GitHub repo.
7. If you would like to create a statically generated website from the Markdown files, check out KabukiPress. We are seeking Modern Embedded-C++ code contributors.
This template is not copyrighted. We're assuming you're making a commercial application so this is just an example strong closed-source license. If you are trying to create a source available license, which is the strongest open-source license, replace the license paragraph with "You must consult your personal license for permissions and restrictions."
Copyright 2021 © Cale McCollough.
This file and the folder and repository it is contained in are private and contain intellectual property, trade secrets, copyrighted material, and other protected works, the IP, that are the property of the IP Owner. You must get explicit permission from the IP Owner to possess, view, modify, share, duplicate, discuss, or publicly display the IP.