m0smith / malabar-mode

EMCS JVM Integration for Java and other JVM based languages
GNU General Public License v2.0
330 stars 52 forks source link

Improve Installation Documentation #183

Open VincentToups opened 9 years ago

VincentToups commented 9 years ago

I'm eager to use Malabar mode and to escape the tyranny of smart IDEs with dumb editors.

However, all one can tell from the current Readme is that Malabar-mode is in flux - its very difficult to determine exactly what needs to happen to get a running setup.

Two issues in particular stand out:

  1. The installation section begins "It is currently in a beta stage. Once it has some time to mature, it will be put back into MELPA. Until then, the installation is manual:" but step 4 says "install malabar mode from melpa"
  2. I gather from the existence of malabar-mode-jar repo and other comments that there is a java/groovy side component which needs to be installed, but this isn't covered in the 2.0 installation instructions.

I can see from other people's posts that at least some folks are working with Malabar mode right now. I would be nice to improve the instructions so others could quickly reach parity and contribute to the project.

m0smith commented 9 years ago

I will try over the next day or two. As a quick hint, use the develop branch. 

Sent from my T-Mobile 4G LTE Device

-------- Original message --------
From: Vincent Toups notifications@github.com
Date:09/08/2015 11:37 AM (GMT-07:00)
To: m0smith/malabar-mode malabar-mode@noreply.github.com
Subject: [malabar-mode] Improve Installation Documentation (#183)
I'm eager to use Malabar mode and to escape the tyranny of smart IDEs with dumb editors. However, all one can tell from the current Readme is that Malabar-mode is in flux - its very difficult to determine exactly what needs to happen to get a running setup. Two issues in particular stand out: The installation section begins "It is currently in a beta stage. Once it has some time to mature, it will be put back into MELPA. Until then, the installation is manual:" but step 4 says "install malabar mode from melpa" I gather from the existence of malabar-mode-jar repo and other comments that there is a java/groovy side component which needs to be installed, but this isn't covered in the 2.0 installation instructions. I can see from other people's posts that at least some folks are working with Malabar mode right now. I would be nice to improve the instructions so others could quickly reach parity and contribute to the project. — Reply to this email directly or view it on GitHub.
hangingman commented 8 years ago

I also need more detailed document. Especially, I still don't figure out how to create a project file for malabar-mode.