Skip to content

Commit

Permalink
version: set version number
Browse files Browse the repository at this point in the history
  • Loading branch information
uditkarode committed Nov 27, 2018
1 parent 7e93f50 commit ef7cc83
Showing 1 changed file with 1 addition and 35 deletions.
36 changes: 1 addition & 35 deletions docs/version
Original file line number Diff line number Diff line change
@@ -1,35 +1 @@
# 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.

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 :

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

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

```bash
ucc --workspace /Users/udit/myProjects
```

##### These commands below will do the heavylifting for you. You can copy and paste them to your terminal directly. Input 'yes' if asked. After executing them, your workspace will be ~/UCCRoot :

```bash
cd ~
mkdir UCCRoot && cd UCCRoot
ucc init
ucc --workspace .
```

After setting up UCC, you can compile and run your programs with a command as simple as this!
```bash
ucc -br program.cpp
```

For instructions on usage of the script, use `ucc --help`

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

1 comment on commit ef7cc83

@uditkarode
Copy link
Owner Author

@uditkarode uditkarode commented on ef7cc83 Nov 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did I even add readme into that lel

Please sign in to comment.