This is simply a demonstration repository, the contents are free to use by anyone who wishes to do so.Īgain when you save the file, Git will detect it and it will appear in the Git pane marked as untracked. This repository was constructed by ( "Michael Gledhill"). This repository is intended to be used with the accompanying documentation ( "Practical Series - Git and GitHub"). This repository is a worked example demonstrating how to build a version control project using Git and GitHub from within the Brackets text editor. The full set of PracticalSeries publications is available at ( "Practical Series Website"). This particular repository is designed as an example project to demonstrate how to build a Git and GitHub repository using the Brackets-Git extension for the Brackets text editor. It contains a number of online publications designed to help and explain how to build a website, how to use version control and how to write engineering software for control systems. The **Practical Series of publications** is a website resource for web developers and engineers. If both are present, it will display README.md in preference to readme.md.ĭouble click the new file and add the following code to it: There is no actual requirement for this GitHub will quite happily use readme.md instead. The README.md file is by convention written with README in capitals (I think to make it noticeable). In Brackets, right click the bottom of the file tree and click new file and then rename the new file as README.md †2. It needs to be in the root of the project folder. Licence (unless listed in another document) Links to other documentation (if not all contained here) The README.md should contain certain specific things:Īn Introduction (what the project is for) Here's an example input file for the "dot" program (file name "test.GitHub uses a slightly more advanced version of Markdown, this is called Git Flavoured Markdown and allows images, code fragments and some directly encoded HTML.Īppendix c gives a summary and some examples of both Markdown and Git Flavoured Markdown. It can output the drawing as PDF, SVG, PNG, JPG, etc.
To do that, you create a text file defining each file or folder as a unique node and the connections between them (parent to child)ĭot is a part of the Graphviz toolkit, documentation is online at: I use a command-line program called "dot" to draw tree structures.
0 kommentar(er)
