Skip to content

Commit

Permalink
Updated README.md to comply with the last commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
uditkarode authored Nov 7, 2018
1 parent 8ea9c75 commit 3a204e1
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# UCC

#### This was built for the students of schools/colleges that still use TurboC++ and it's archaic code samples, and asks them to do the same. In order to use this, you need a Linux/Unix based system, or a Windows 10 installation with the Windows subsystem for Linux installed. You must have DosBox 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 it's archaic code samples, and asks them to do the same. In order to use this, you need a Linux/Unix based system that can run DosBox. You must have DosBox 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.

To get started, create a directory anywhere on your disk, which will be your workplace. Let's call it the **root folder**. Add the *BIN* folder from this repository into your *root folder*. Also, inside the root folder, create three directories :
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 three directories :

- 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)

Now, enter the complete location of the *root folder* on your filesystem in the file *ucc*, as such:
Now, set the complete location of the *workspace*, as such:

```bash
#!CHANGE THIS TO YOUR ROOT FOLDER!
root=/Users/udit/Class12File
ucc --workspace /Users/udit/myProjects
```

##### Get started now by running these commands:
##### These commands below will do the heavylifting for you. You can copy and paste them to your terminal directly. After executing them, your workspace will be ~/UCCRoot. You can obviously change it to whatever you want. :

```bash
sudo -s
cd /tmp && git clone https://github.com/uditkarode/ucc.git
Expand All @@ -24,7 +24,8 @@ mkdir builds logs sources
cp -r /tmp/ucc/BIN .
mv /tmp/ucc/ucc /bin/ucc && chmod +x /bin/ucc
rm -r /tmp/ucc
echo "Change the root variable in the file /bin/ucc to ~/UCCRoot, otherwise this script will NOT work."
ucc --workspace ~/UCCRoot
echo ""
```

Here is the script command usage:
Expand All @@ -35,5 +36,10 @@ Here is the script command usage:

NOTE: Filenames longer than 8 characters should have the first 6 characters and ~1 attached. If the filename is longer than 8 characters but there is a dot(.) before the eighth character, place a '~1' after the filename before the dot.

For Example,
Q1.cpp.EXE is longer than 8 characters, and has a dot before the eighth character. Hence to run it, you need to type **ucc --run Q1~1**

THISISTEST.cpp.EXE is longer than 8 characters but does not have a dot before the eighth character. Hence to run it, you need to type **ucc --run THISIS~1**

In the words of Bob the Builder:
> Happy Building!

0 comments on commit 3a204e1

Please sign in to comment.