Skip to content

Commit

Permalink
docs: update index to match readme
Browse files Browse the repository at this point in the history
  • Loading branch information
uditkarode committed Dec 7, 2018
1 parent c1ad460 commit a1fd16a
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ bash ucc -br abc.cpp

After executing UCC-INIT, you will have the five directories. You know what to do next.

#### POSIX:
#### *NIX:

###### MANUAL METHOD:
To get started, create a directory anywhere on your disk, which will be your workplace. Let's call it the **workspace**. Add the *BIN* folder from this repository into your *workspace*. Also, inside the workspace, create the five directories mentioned above.
Expand Down
43 changes: 35 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,42 @@
# UCC

#### This was built for the students of schools/colleges that still use TurboC++ and teach it's archaic code samples, and ask its students to use the same. In order to use this, you need a Linux/Unix based system that can run DosBox. You must have DosBox, wget and curl preinstalled on your system. It is not mandatory to run this script as a user with superuser privileges, but it is necessary for the user running the script to have access to the entirety of the required assets.
##### This was built for the students of schools/colleges that still use TurboC++ and teach it's archaic code samples, and ask its students to use the same. In order to use this, you need a Linux/Unix based system that can run DosBox. If you use Linux/Unix, you must have DosBox, wget and curl preinstalled on your system. It is not mandatory to run this script as a user with superuser privileges, but it is necessary for the user running the script to have access to the entirety of the required assets.

###### MANUAL METHOD:
To get started, create a directory anywhere on your disk, which will be your workplace. Let's call it the **workspace**. Add the *BIN* folder from this repository into your *workspace*. Also, inside the workspace, create four directories :
#### Common Instructions:
*EVERY* valid UCC Workspace will contain these folders:
- `builds/` (this will contain the built EXE files)
- `sources/` (this will contain the C/CPP source code)
- `logs/` (this will contain the build and DosBox logs)
- `files/` (this will contain the files created through C/C++ using filestreams)
- `headers/` (this will contain your custom header files)

#### WINDOWS:
Since most of Windows users do not have git, I zipped the files of the `windows` branch and added it to this repo. Instead of downloading the zip file, you can also clone the `windows` branch.

To install UCC for Windows, download https://uditkarode.github.io/ucc/ucc-windows.zip.

Wherever you extract this will be your workspace.

After extraction, **you must run** `UCC-INIT.bat`. The file will set up the directory and automatically remove itself.

You can now use `UCC-BUILD.bat`, `UCC-RUN.bat`, or `UCC-BUILD-RUN.bat` to compile, run, or compile and seamlessly run respectively.

If you prefer direct command line usage, you can change directory to the assets folder and use ucc this way:
```bash
bash ucc --build abc.cpp
bash ucc --run abc.cpp.EXE

--OR--

bash ucc -br abc.cpp
```

- builds/ (this will contain the built EXE files)
- sources/ (this will contain the C/CPP source code)
- logs/ (this will contain the build and DosBox logs)
- files/ (this will contain the files created through C/C++ using filestreams)
- headers/ (this will contain your custom header files)
After executing UCC-INIT, you will have the five directories. You know what to do next.

#### *NIX:

###### MANUAL METHOD:
To get started, create a directory anywhere on your disk, which will be your workplace. Let's call it the **workspace**. Add the *BIN* folder from this repository into your *workspace*. Also, inside the workspace, create the five directories mentioned above.

Now, set the complete location of the *workspace*, as such:

Expand Down
Binary file removed screenshots/ucc-posix.png
Binary file not shown.

0 comments on commit a1fd16a

Please sign in to comment.