Skip to content

Commit

Permalink
Refine: documents before release
Browse files Browse the repository at this point in the history
* add marketplace url in READMEs
* add CHANGELOGs
* ignore cache folder
* wording in README
  • Loading branch information
kenkangxgwe committed Jan 13, 2019
1 parent fd7bd10 commit 6973b78
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,6 @@ typings/

# output for typescript
**/out

# cache fodler
wlServerCache/
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2019-01-12

### Added

- A state-less server to handle messages, via TCP socket protocol.

- Support for the following language features:

- Hover: Provide definitions for variables with usage message.

- Completion: for wolfram system names.

- Completion Resolve: Further information would be provided for the items in
the list.

- Diagnostics: Syntax error would be underlined.

- Support for exporting temporary SVG images for the information of the variables.

- A type system with pattern test.

- A unit test framework.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ client would certainly work too.
```

2. Install the client. Currently, we provide the VS Code extension on [Visual
Studio Marketplace: Wolfram Language Server]()
Studio Marketplace: Wolfram Language Server](https://marketplace.visualstudio.com/items?itemName=lsp-wl.lsp-wl-client)

## Run the Server

Expand Down Expand Up @@ -89,9 +89,9 @@ Language](https://marketplace.visualstudio.com/items?itemName=flipphillips.wolfr

Here is a full list of [LSP features](https://microsoft.github.io/language-server-protocol/specification).

## Contributions
## Contribute

### Design Principle
### Design Principles

1. The files are located according to its context name. The `init.wls` is the
entry script that parses the commandline arguments, loads packages
Expand Down
15 changes: 15 additions & 0 deletions client/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2019-01-12

### Added

- Add support to wolfram language format

- Lauch server via node module in `serverOption`.

- Passing `theme` via `intializationOptions`.
2 changes: 1 addition & 1 deletion client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ However, you still need to manually install the
```

2. Install the client extenstion from [Visual Studio Marketplace: Wolfram
Language Server]().
Language Server](https://marketplace.visualstudio.com/items?itemName=lsp-wl.lsp-wl-client).

## Client Settings

Expand Down

0 comments on commit 6973b78

Please sign in to comment.