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

readme improvements for iPython-Kerner-Changes #6 #7

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.idea
ENV
ExampleNotebooks/.ipynb_checkpoints
ExampleNotebooks/.ipynb_checkpoints

# Mac files
.DS_Store
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# iPython-Kerner-Changes

<!---
1. Include Java Version
2. Instructions to set it up
-->

1. [Introduction](#introduction)
2. [Dev Set Up](#dev-set-up)
3. [Features](#features)

## 1. Introduction<a name="introduction"/>


### Docker Instructions (Recommended)

1. `docker build -t dimuthuupe/ipykernel:1.0 .`
Expand Down Expand Up @@ -29,3 +41,6 @@
##### Start Tracing Server

1. `sudo python3 tools/tracing-server/strace_server.py`

#### Known Issues
- [Issue with Mac M1](https://github.com/SciGaP/iPython-Kerner-Changes/issues/8#issue-1383841536)