From caaca9fc286a89200cedf4a7eb541a06fe7dd9b5 Mon Sep 17 00:00:00 2001 From: RK117 Date: Thu, 21 Dec 2023 05:39:09 -0800 Subject: [PATCH] readme added --- README | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..65b795b --- /dev/null +++ b/README @@ -0,0 +1,12 @@ +Hello, this is the repository for the repo differ script and files, made for Spiri Robotics by O. Kaya. + +INCLUDED: +- SpiriQGC: A modified version of QGC(can and should be deleted after script is run once(it already has been in this repo), here only for demonstration) +- QGC original repository v4.2 +- input_file.txt: a git diff of additions and changes over QGCv4.2 made by SpiriQGC +- formatter.sh: the main software, takes input_file.txt(run the command ./formatter.sh input_file.txt), and outputs the following: + - spiri_src: has subdirs added and modded, which carry the respective files from SpiriQGC. + - formatted_files.json: lists the src of where the newly moved files in spiri_src and their respective destinations in QGC. + - output.txt: it doesn't actually output this but prints it to console when run on my end, three files don't seem to work, shouldn't be an issue as they're the .gitignore, .gitmodules, and copy.txt(the only mystery one) + +Every other file present on the base directory(.ackrc, .gitignore, .gitmodules, .travis.yml, vagrantconfig.yml, .ycm_extra_conf.py) is some form of leftover that isn't visible on my end, this may have been what caused the 3 errors in the formatter output. \ No newline at end of file