Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,35 @@
clojure-intro-class
===================

A pilot project to use Clojure for introductory computer science courses at the University of Minnesota - Morris
## Introduction

This repository contains both error-related tools, versions of core functions with preconditions, and a string library for beginners.
A _pilot_ project to use Clojure for introductory Computer Science courses at the University of Minnesota, Morris. The main goal of the project is to provide beginner-friendly tools such as
more detailed & human-readable error messages and easy-to-use graphics library.

## Features

* error-related tools (GUI to show the errors)
* versions of core functions with pre-conditions
* string library for beginners

## Quick Start
:heavy_exclamation_mark: Make sure [leiningen](https://leiningen.org/) is installed.

Clone and run this repository to see the app in action.
```
git clone https://github.com/Clojure-Intro-Course/clojure-intro-class.git
cd clojure-intro-class
lein run
```

This runs the code in `src/intro/test.clj` file. Open your favorite editor
and write your own code in the file.

If you want to run your code in standard mode, write your code in
`src/intro/test_standard.clj` file and run lein with `s` arg.
```
lein run s
```

## License
TBA :speech_balloon: