Browse Source

Add comments

Marcelo Fornet 6 years ago
parent
commit
9cd37899b6
3 changed files with 51 additions and 37 deletions
  1. 8 4
      README.md
  2. 43 0
      sug.txt
  3. 0 33
      vsc-extension-quickstart.md

+ 8 - 4
README.md

@@ -24,7 +24,7 @@
 
 * Add more testcases than provided in statement using `Add Test Case`, or modify and see existing testcases by calling `Open Test Case`.
 
-* If your solution keep failing you can stress it using a generator and a brute solution. Call `Upgrage` to create both generator (`gen.py`) and correct (`brute.cpp`) programs. Right now generator must be written in python, and correct program must be written in C++. After both codes are ready just call `Stress` and your original code will be tested on random test cases from generator against correct solution.
+* If your solution keep failing you can stress it using a generator and a brute solution. Call `Upgrage` to create both generator (`gen.py`) and correct (`brute.cpp`) programs. Right now generator must be written in python. After both codes are ready call `Stress` and your original code will be tested on random test cases from generator against correct solution.
 
 The environment structure is the following:
 
@@ -54,13 +54,13 @@ You need to tell **acmX** which folder are you going to use, to save all the pro
 
 * Open settings (from command palette) or `Ctrl+,`
 * Go to `acmx.configuration.solutionPath`
-* Set this value to the path you are going to use to store contests and problems. (e.g. `/path/to/my/solutions`)
+* Set this value to the path you are going to use for storing contests and problems. (e.g. `/path/to/my/solutions`)
 
-I encourage everyone to read and change [all settings](#settings) so you can customize **acmX** for you. Anyway, after updating `acmx.configuration.solutionPath` it should work good for C++ users.
+I encourage everyone to read and change [all settings](#settings) before first use. Anyway, after updating `acmx.configuration.solutionPath` it should work good for C++ users.
 
 ## Default template is awful, how can I change it
 
-Create a file with your template. In settings change `acmx.configuration.templatePath` to the path of your templates file.
+Create a file with your template. In settings, set `acmx.configuration.templatePath` to the path to your template.
 
 ## What is contest id on each platform
 
@@ -70,6 +70,10 @@ You can find this information for every supported platform [here](doc/platforms-
 
 Yes, of course, and any other language you want. Just make sure to update your [language configuration](doc/languages.md) setting.
 
+## This problem has multiple correct answers, what can I do
+
+TODO: Coming soon. Read minitutorial on configuring custom checker.
+
 ## Commands
 
 Call this commands from the command pallete (`Ctrl + Shift + P`).

File diff suppressed because it is too large
+ 43 - 0
sug.txt


+ 0 - 33
vsc-extension-quickstart.md

@@ -1,33 +0,0 @@
-# Welcome to your VS Code Extension
-
-## What's in the folder
-* This folder contains all of the files necessary for your extension.
-* `package.json` - this is the manifest file in which you declare your extension and command.
-The sample plugin registers a command and defines its title and command name. With this information
-VS Code can show the command in the command palette. It doesn’t yet need to load the plugin.
-* `src/extension.ts` - this is the main file where you will provide the implementation of your command.
-The file exports one function, `activate`, which is called the very first time your extension is
-activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`.
-We pass the function containing the implementation of the command as the second parameter to
-`registerCommand`.
-
-## Get up and running straight away
-* Press `F5` to open a new window with your extension loaded.
-* Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
-* Set breakpoints in your code inside `src/extension.ts` to debug your extension.
-* Find output from your extension in the debug console.
-
-## Make changes
-* You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
-* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
-
-## Explore the API
-* You can open the full set of our API when you open the file `node_modules/vscode/vscode.d.ts`.
-
-## Run tests
-* Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Extension Tests`.
-* Press `F5` to run the tests in a new window with your extension loaded.
-* See the output of the test result in the debug console.
-* Make changes to `test/extension.test.ts` or create new test files inside the `test` folder.
-    * By convention, the test runner will only consider files matching the name pattern `**.test.ts`.
-    * You can create folders inside the `test` folder to structure your tests any way you want.