Skip to content
This repository was archived by the owner on Jul 19, 2022. It is now read-only.

Commit 02cf50b

Browse files
authored
Update README.md
1 parent bb0747a commit 02cf50b

File tree

1 file changed

+2
-30
lines changed

1 file changed

+2
-30
lines changed

README.md

+2-30
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,4 @@
11
Unison Codebase UI
22
==================
3-
4-
[![CI](https://github.com/unisonweb/codebase-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/unisonweb/codebase-ui/actions/workflows/ci.yml)
5-
6-
Running Development Server
7-
--------------------------
8-
9-
🔔 You should only need to run the UI development server if you're contributing to the UI. If you just want to run the UI to see your Unison codebase, it should either come pre-installed with `ucm` or if you built from source can be downloaded with a script: `./dev-ui-install.hs` from the `unison` repository ([Running Unison](https://github.com/unisonweb/unison/blob/trunk/development.markdown#running-unison)).
10-
11-
1. Start `ucm` (the executable is `unison` instead of `ucm` if you built the [unison repository](https://github.com/unisonweb/unison) from source) in headless mode: `ucm headless`, and copy the API URL (this URL
12-
is uniquely generated by `ucm` at start-up) from the `ucm` start-up output
13-
(`ucm` also outputs a UI URL, but this isn't used when developing for the
14-
UI/running the UI from this repository).
15-
16-
2. Make sure the latest dependencies are installed with by running `npm install`
17-
18-
3. Start the Unison Share dev server with: `API_URL="<API URL FROM UCM>" npm run start:unisonShare` or the Unison Local dev server with: `API_URL="<API URL FROM UCM>" npm run start:unisonLocal`
19-
20-
4. Visit `http://localhost:1234` in a browser.
21-
22-
Adding new Icons
23-
----------------
24-
25-
To add new icons, copy the SVG markup to a new function in `/src/UI/Icon.elm`
26-
following the convention seen there of other icons. The color (`fill` or
27-
`stroke`) of the shape must be
28-
[`currentColor`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/color).
29-
30-
Community
31-
--------
32-
[Code of conduct](https://www.unisonweb.org/code-of-conduct/)
3+
This is now archived version of the UI.
4+
[Unison Local UI](https://github.com/unisonweb/unison-local-ui) and [UI Core](https://github.com/unisonweb/ui-core) has replaced this repository.

0 commit comments

Comments
 (0)