This project in the System engineering & DevOps series is about: This is a little example of what this baby can do~ !! This is a fun little thing I worked on, but its still easy to make your own readme without it. And could be faster? So if you find this script slower than you would be able to make it yourself! don't bother~ For those of you who don't have a template for a README and a lot of people suggest keeping you README organize, this is great for you (although it is a lot more wwork if you want your README to be a couple lines)
Shoutout to Victor nguyen for giving us advice and letting me use his template, so basically it goes like this. Title Description task|answer and my script will let you copy and paste the title copy and paste the description and go thorugh the task one by and giving the answer if you want.
To use this ... go to your home directory
open .profile in your editor
copy and paste the code in nrScript to the very end
save/exit
In the terminal type :
"source ~/.profile" without the quotes //(this will I think update the funcitons in there)
When you create your repository or folder for the next project
type nr in the directory and go through the interactive guide to creating a clean README
Example: nr
Type or paste your title
Type in your description or copy and paste and press enter
ctrl+d to tell the program to stop looking
type 1 to type the task only or 2 to type both task and answer at the same time
New option! Create files while you add your task
11- to add just task and create the file
22- to add task | answer and create the file
What you want to copy and paste: the file name
after that it will ask you if you want to commit, save and exit, or delete the README
Thats it! If there are any issues then slack me and ill do my best to fix it.
| File | Task |
|---|---|
| Just an example | for the table |
| you would type in the task name | and type in the answer next |
| You can just type the title | and later on you can open your editor to go through the answer |
| Enjoy!~ | easy coding |
| File_Name | ... |
Shoji Takashima